Cream of the Crop 12

home *** CD-ROM | disk | FTP | other *** search

/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / FLMD134.ZIP / FLM.DOC < prev next >

Wrap

Text File | 1996-03-03 | 43.1 KB | 1,256 lines

************************************************************** * * * * * ******* **** ** ** * * ** * ** *** *** * * ** * ** ******* * * **** ** ******* * * ** * ** * ** * ** * * ** ** ** ** ** * * **** ******* ** ** * * * * * * A flexible File List Manager for Maximus (*) * * * * * ************************************************************** * * * (C) Copyright 1991-1996 by Alberto Pasquale * * * * A L L R I G H T S R E S E R V E D * * * ************************************************************** (*) Maximus is a trademark of Lanius Corporation FLM 1.34 User's Manual, by Alberto Pasquale INTRODUCTION -> For licensing information, please see License.Doc. Thanks for evaluating FLM: a File List Manager for Maximus(*). Main characteristics: - To be used with Maximus 3.xx by Scott J. Dudley. - One-Pass generation of multiple file lists. - Internal generation of Maximus File Base and indexes (no need for external FB/FBP). - Generation of UniFiles.Idx in addition to MaxFiles.Idx to allow File-Requests with no duplicates with Binkley(**). - New file announcement. - Support for separate "Creation" and "Modification" dates in HPFS, following the Max 3.xx convention: the "Creation" date is used as the "upload" date, to recognize new files; the "Modification" date is used to list the file date. - Duplicate file report. - EchoToss.Log support. - Cfg support for external commands, to keep all stuff related to list generation in the FLM.CFG. - Selective Adoption of Orphans. - Selective description deletion for missing files. - Minimum configuration effort required. - Okfile generation. - Okfile support for a fixed header and variable Magics. - Mutually Exclusive access to the filebase (for other ApWorks programs). - Support for multi-line descriptions. (*) This program uses the Squish MsgAPI code, Copyright 1991-1994 by Lanius Corporation. Squish and Maximus are trademarks of Lanius Corporation. (**) Binkley is Copyright 1988-1994 Bit Bucket Software INSTALLATION 1) Edit flm.cfg. In the case you do not use the "MAXIMUS" environment variable to point at the current MAX.PRM, you must use the "MaxPrm" statement. 2) Edit your maintenance batch in order to call FLM. 3) OS/2: Make sure you have the MSGAPI32.DLL file in your LIBPATH. DOS: Make sure you have the DOS4GW.EXE DOS extender in your path. FLM.Exe must obviously be in your path. FLM.Cfg must be in the current directory. Command line switches -c<cfgfile> Cfg file override -h or -? Help Example: FLM -cc:\max\flm.cfg Errorlevels 0 - Normal termination 1 - Error in CFG 2 - Help Requested 3 - Abnormal termination 4 - Cfg file not found 5 - File Base is Busy (TimeOut) 10 - Prefix or Suffix too long 250 - MsgApi Init Error 251 - Area Open Error 252 - Error Opening output list 253 - Cannot read max.prm 254 - Cannot open logfile 255 - out-of-memory OVERALL OPERATION FLM scans all the file areas in FAREA.DAT (or the equivalent file defined in Max.prm). FLM writes all the output files in one pass: for every area all the unused output files are closed and the used ones are opened. If too many output files are required at the same time, FLM could exit with a "cannot open file" or "too many files to open" error: see the "Files <num>" cfg statement to increase the available file handles. In the FILES.BBS, lines starting with a space ' ' or a dash followed by space "- " or empty are considered as comment. The optional path specification in the files.bbs is supported. The three dating styles ("Automatic", "List", "Manual") of Max 3.00 are supported. Areas that are offline (e.g. CDROMs not in the drive) can still be listed provided they are defined in filearea.ctl with a separate (and online) "FileList" and are of "Type DateList"; in the output lists generated by FLM, these areas will be marked with "Offl" just before the area description. CONFIGURATION FILE FLM requires a configuration file (defaults to FLM.Cfg). Before using FLM you should edit this file, following the comments in the sample one. General Conventions - Items between square brackets (e.g. [<item>]) are optional. - Items separated by '|' are mutually exclusive (e.g. C|H|D|N|O). - The names of the various Keywords are NOT case sensitive. - The area TAGs are NOT case sensitive. - When a directory path is required, the trailing backslash '\' is optional. - The ';' character starts comments: any character following the ';' is ignored. Please note that configuration text strings (e.g. Subj, Origin) must be specified between double quotes to allow the ';' character. - The maximum length of configuration lines is 254 characters. - Unless differently specified, addresses are standard 4D and MUST begin with the zone number. - <WTag> is a "Wild TAG" specification: it can be a normal area TAG or contain wildcards ('?' and '*') in the "OS/2 style". If you specify the '*' alone, all tags will be included, except for the "<special>" ones. Examples: 1!* includes all the tags starting with "1!". * includes all the normal tags, does not include the special tags like "<DEF>" or "<DUPES>". 1!LOCAL specifies the "1!LOCAL" area. LOCAL.* specifies the LOCAL division. *LOCAL* specifies all areas whose tag contains "LOCAL". UP.??? specifies all areas of division "UP" with up to 3 characters after the point. <DUPES> specifies the "dupe-file report". <DEF> specifies the announcement of all new files not announced elsewhere. <CDROM> specifies all the areas that are either marked as "Type CD" in filearea.ctl or detected as read-only by FLM, for NoAdopt and NoRemMis statements ONLY. - <filename> is a fully qualified filename with optional drive and path. - <filespec> is a filename (no path, wildcards * and ? accepted) - The wildcards work the same as in OS/2 commands. * stands for 0 or more characters ? stands for 1 character (0 or 1 when at the end) . is a character as all the others Examples: 'dummy' does not match 'dummy.txt' 'dummy*' matches 'dummy.txt' 'du?mmy.txt' does not match 'dummy.txt' 'dummy.txt?' matches 'dummy.txt' 'du*y.txt' matches 'duy.txt' 'du*?y.txt' does not match 'duy.txt' 'du*?y.txt' matches 'dumy.txt' 'du*y.txt' does not match 'duo.txt' - ... means that you can list further items of the same type. - Whenever you have to specify a list of tags or paths, you can use multiple lines if you want: Adopt WIN* SDN* is equivalent to: Adopt WIN* Adopt SDN* - <ACS> is a maximus access string Favored Favored/1A 1000/!2 >=500|twit/A <=300/b&disgrace/!c - <num> is an integer number Please, note that the order of the configuration statements follows some logical rule. In order not to create confusion in the .cfg file and not to break some _necessary_ order relation, please follow the scheme proposed in the example CFG file and in this reference documentation. Global Keywords The following statements are "Global" in scope, i.e. they affect all the operations of FLM. StatusLog <filename> The usual Binkley Style logfile. Files <num> It is used to increase the number of files that can be open at the same time. The Operating System allows 20 files per process by default, including the 5 "standard" ones. If you need FLM to open many files, you might need to increase this limit. When you use this statement (with <num> > 20), FLM reports both on screen and to the logs the exact total number of files that can be open at the same time (can be >= <num>). DOS: WARNING: You need to specify a "Files=<num>" statement in your config.sys also. The "Files <num>" specification in FLM.cfg does not allow FLM to use more files than specified in the "Files=<num>" statement in your config.sys. E.g.: "Files=50" Example: Files 50 MaxPrm <filename> The Maximus parameter file. This is an override for the "MAXIMUS" environment variable. SquishCfg <filename> It is used to specify the squish configuration file, so that FLM can automatically get the path, type (SDM vs Squish) and primary address for the announcement areas defined with the "AreaTag" statement. When SquishCfg is defined, if you use "AreaTag <Tag>" to define announcement areas, the "FromNode <adr>" statement is only used to override the primary address specified for that area in Squish.Cfg (including the -p<address> overrides). FLM supports the "Include" keyword of Squish.Cfg: just be sure to always use the full pathname in the Include statement if FLM and Squish run from different paths. Both echomail and netmail areas are recognized by their Squish tags. Netmail areas will have the Private attribute and no origin by default. Local overrides are still possible through local "Origin" and "Attr" statements. EchoTossLog <filename> It is used to override the specification found in the Maximus control file, that FLM gets from Max.Prm. When FLM writes echomail messages in areas defined with the "AreaTag" statement, the corresponding echomail tags are appended to this file, one per line. If you do not like this output, you can override with the NUL name: "EchoTossLog NUL". DateFormat USA|EURO|JAPAN It sets the date format for file lists and message reports to mm-dd-yy, dd-mm-yy, yy-mm-dd respectively. Example: DateFormat EURO FBCompile FLM will compile the Maximus filebase while generating the file lists. Both MaxFiles.Idx and UniFiles.Idx (with no duplicates) will be created. This keyword is implied, thus redundant, when the "OkMaxFiles" statement is used. A flag "FileBase.Bsy" in the Maximus system directory allows for mutually exclusive access to the filebase files and is supported by other ApWorks programs. In the case of power failure or abnormal termination, there is no need to "manually" delete this flag file: ApWorks programs are smart enough not to be deceived by a "zombie" :-) UniqueDmpLine Makes FLM generate FILES.DMP filebase files with descriptions on one line only (multiple lines are concatenated). By default, FLM outputs multi-line descriptions without changes to FILES.DMP: when using L)ocate and N)ewfiles commands, Maximus will respect the original formatting, but the continuation lines will be aligned to the left. When this statement is used, the original formatting of descriptions is lost (in the filebase) but Maximus will be able to word-wrap and align when executing L)ocate or N)ewfiles commands. AreaExclude <WTAG> ... The specified areas are completely excluded from processing. Adopt <WTag> ... Areas where you want to adopt orphans. This function works in areas with "Automatic dating", only. NoAdopt <WTag> ... Areas to be excluded from adoption. You should usually exclude CD-ROMs using the "special" tag <CDROM>. If you are using the files.bbs directly on CD, FLM will automatically exclude adoption on the area. Example: Adopt * NoAdopt <CDROM> RemMis <WTag> ... Areas where you want to remove descriptions of missing files. This function works in areas with "Automatic dating", only. WARNING: if you use multi-line descriptions (multiple lines in the files.bbs), then you must pay attention to configure the "MultiLineDesc" statement correctly, otherwise the continuation lines will not be recognized and they might be removed when they should not or vice-versa. NoRemMis <WTag> ... Areas to be excluded from RemMis. You should usually exclude CD-ROMs using the "special" tag <CDROM>. If you are using the files.bbs directly on CD, FLM will automatically exclude RemMis on the area. Example: RemMis * NoRemMis <CDROM> WrapCol [<num> [<num>]] Enables word wrapping of long descriptions in file lists. The optional <num>s give the left and right margins for word wrapping (default to 0 and 79). Suggested values: 31 and 79. Example: WrapCol 31 79 MultiLineDesc <nnn> [<c>] By default, files.bbs description must be on a single line; this statement enables Multi-Line support. <nnn> is the number of spaces that must precede the continuation lines. <c> is the continuation character. If <c> is NOT specified, it is assumed that the continuation lines must be preceded by <nnn> spaces. If <c> IS specified, it is assumed that the continuation lines must be preceded by <nnn> spaces, the <c> character and one more space. For example, when the 2nd and following description lines in files.bbs start at the 32nd column, use: MultiLineDesc 31 A description in files.bbs would be like: Test.Zip This is the first description line this is the 2nd line this is the 3rd line ^ ^^ 1 31 32 When the continuation lines are preceded by a '|' character, use: MultiLineDesc 29 | A description in files.bbs would be like: Test.Zip This is the first description line | this is the 2nd line | this is the 3rd line ^ ^ ^ 1 29 32 AdoptExclude <filespec> ... Excludes the specified files from adoption. Files.* and *.BBS are excluded anyway. Example: AdoptExclude *.BAK NoAnnDupeTag <WTag> ... NoAnnDupePath <PartPath> ... Exclude areas from dupe report, by TAG or Path. In the case you have lots of dupes you do not want announced (e.g. on CDROMs), you can exclude areas (NoAnnDupeTag) or paths (NoAnnDupePath). All dupes will be removed from the UniFiles.Idx anyway. <PartPath> is a partial path specification: all the dupes that have a path beginning with <PartPath> will not be announced. Note: Please be aware that you could have the announcement of a single file as "dupe" if it is not excluded while its corresponding duplicate is. Example: NoAnnDupeTag 1!apw* GFX* NoAnnDupePath d:\bbstest\file\1!apb g: h: Start of File List You can generate as many file lists as you like. The cfg section that defines the generation of a file list starts with the ListPriv statement, followed by a group of "local" keywords. ListPriv <ACS> Areas with level/keys that do not grant access to <ACS> will not be listed. Areas contained in a Division that can't be accessed with <ACS> will not be listed too. Example: ListPriv Favored/1A Local Keywords The following keywords refer to the preceding ListPriv statement: you can generate multiple file lists by using multiple ListPriv statements, each one followed by its group of "local" keyword. ListAreas <WTag> ... Areas to be listed (if they match the <ACS> requirement). Example: ListAreas * NoListAreas <WTag> ... Areas to be excluded from current list. NewDays <num> Files newer than <num> days (basing on the upload date) are listed in the NewFiles list and marked with asterisk in the AllFiles one. Default: 30 NewHeader <filename> Header for NewFiles list. Default: no header. NewFiles <filename> Output file for new-file list. Default: no output file. AllHeader <filename> Header for AllFiles list. Default: no header. AllFiles <filename> Output file for all-file list. Default: no output file. NewFilesCmd <cmd> AllFilesCmd <cmd> They allow easy integration in FLM.CFG of the commands related to FLM that must be executed after the generation of the file lists (as defined in the current NewFiles and AllFiles respectively) is complete (instead of putting them in the calling batch file). If the command does not begin with the name of an executable file, the default command interpreter is invoked. The "%f" parameter can be used to represent the name of the file (as specified in the NewFiles and AllFiles statements respectively). In case of multiple commands, you can invoke a batch file (.CMD (OS/2) or .BAT (DOS)) or use multiple "NewFilesCmd" and "AllFilesCmd": they will be executed in sequence. Note: Usually you will like creating the file lists in a place different from the destination file area, otherwise the file list will show a "0 length" file-list file, since it is "under construction" while FLM examines the area. Example: The commands in the following example are for 4OS2 (trademark of JP Software): if you do not use this excellent command interpreter you would need a slightly different syntax. NewFiles \file\ApWorks.new NewFilesCmd *move %f \file\1!apwork\ AllFiles \file\ApWorks.All AllFilesCmd copy %f \file\1!apwork\ AllFilesCmd zip -mj \file\ApWorks %f AllFilesCmd *move \file\ApWorks.zip \file\1!apwork\ OkHeader <filename> Header for OkFile. Default: no header. OkFile <filename> Output file for OkFile. Default: no output file. OkMaxFiles Use UniFiles.Idx for File Requests instead of the complete list of paths (BT 2.55 or greater). FBCompile is implied, i.e. FLM compiles MaxFiles.Idx and UniFiles.Idx while generating the file lists. MagicFile <filename> List of magics and wildcarded filespecs to be resolved before putting them in the OkFile. FLM gets the most recent file for each filespec and puts it in the OkFile preceded by the Magic. Password protected magics allowed. OS/2: On HPFS the magics are resolved using the upload (creation) date. Example for Magic.Lst: Magic1 c:\file\file1???.zip Magic2 c:\file\file2???.zip pwd1 The second item is protected. FLM will write to the okfile the resolved magics; e.g: @Magic1 c:\file\file1999.zip @Magic2 !pwd1 c:\file\file2888.zip WrapCol [<num> [<num>]] Local WrapCol setting: see the global WrapCol keyword. Can be used with or without a global WrapCol (in the first case the local margin values override the global ones). Example of File List definition ListPriv Extra ; first file list block ListAreas * NoListAreas WIN* WrapCol 31 131 NewDays 30 NewHeader \bbs\misc\apworks.abt NewFiles \bbs\file\ApWorks.new NewFilesCmd *move %f \bbs\file\1!apwork\ AllHeader \bbs\misc\apworks.abt AllFiles \bbs\file\ApWorks.All AllFilesCmd copy %f \bbs\file\1!apwork\ AllFilesCmd zip -mj \bbs\file\ApWorks %f AllFilesCmd *move \bbs\file\ApWorks.zip \bbs\file\1!apwork\ OkHeader \bbs\misc\okhead.lst OkFile \bbs\misc\okfile.lst OkMaxFiles MagicFile \bbs\misc\magic.lst ListPriv Extra ; second file list block ListAreas Local.* AllHeader \bbs\misc\apworks.abt AllFiles \bbs\file\ApFiles.Lst AllFilesCmd *move %f \bbs\file\1!apwork\ New File Announcements FLM can announce new files (upload date later than FLM was last run) found during file list generation. Each announcement area is defined by a dedicated group of statements. Many of these statements can be used before the first announcement area definition to establish defaults to be used in all subsequent area definitions, thus avoiding the need to unnecessarily repeat common statements. The following statements can be used: - before the area definitions to set defaults for all the areas - inside an area definition to override the defaults FromNode <address> This specifies the 4D address to be used as the from-address in the announcement messages: it is used in the header, in the Origin and in the MSGID. Usually, it should be your primary address. Usually this statement is not necessary, since FLM will look-up the from-address for an area in the squish configuration file (see AreaTag). Example: FromNode 2:332/504.0 ToNode <address> This specifies the 4D address to be used as the to-address in the announcement messages: it is used in the header. Usually, for echo area announcements, it should be the same as in FromNode. Default: same as FromNode Example: ToNode 2:332/504.0 From <name> This specifies the name to be used as the from-name in the announcement messages. Usually it should be the SysOp name. Default: "FLM" Example: From Alberto Pasquale To <name> This specifies the name to be used as the to-name in the announcement messages. Usually it should be "All". Default: "All" Example: To All Subj <subject> This specifies the string to be used as the subject in the announcement messages. Default: "New Local Files" Example: Subj New ApWorks Files Attr [P][K][C|H|D|N|O] This specifies the attributes to be used in the announcement messages. Usually no special attribute is necessary, except for private announcements in the netmail area. The available attributes are: P -> Private K -> Kill/Sent C -> Crash H -> Hold D -> Direct (equivalent to "CH") N -> Normal (default) O -> Normal (default) The required attributes can be listed in any order and are not case sensitive. Examples: Attr ; no attributes Attr N ; no attributes (Normal flavour) Attr PK ; Private and Kill/Sent Attr PC ; Private and Crash Attr PDK ; Private, Direct, and Kill/Sent HighAsciiOk Grants permission for High Ascii codes (> 127) in file descriptions. Prefix [<filename>] This specifies the file containing the prefix text for announcement messages: it is put by FLM at the head of the message body, just before the real announcement lines. It should usually contain something like "New Echo Files Received:". To disable the Prefix, omit the <filename>. Examples: Prefix c:\max\PREFIX.FLM Prefix ; no prefix Suffix [<filename>] This specifies the file containing the suffix text for announcement messages: it is put by FLM at the end of the message body, just before the tear-line and the Origin. It should usually contain something like "File Request open to everybody between 06:00 and 23:00 GMT". To disable the Suffix, omit the <filename>. Example: Suffix c:\max\SUFFIX.FLM Suffix ; no suffix Origin [<origin>] This specifies the text to be used as the Origin in announcement messages. FLM will add the required " * " at the head and the address at the end, truncating <origin> if necessary to fit the 79 character maximum length. To disable the Origin (e.g. in netmail area), omit the <origin> string. Examples: Origin <ApWorks Modena Italy><Tel.+39-59-243882> Origin ; empty origin to disable origin generation Start of Area An Area definition starts with the AreaTag or AreaPath statement. The configuration verbs described above in "Global or Local Override" can be used inside each area definition to override the global values. AreaTag <Tag> [<path> [-$]] AreaPath <path> [-$] One of these statements starts the definition of an announcement area. <Tag> usually is the echomail TAG, as defined in Squish.Cfg. <path> is the directory for the *.MSG format or the full filename (no extension) for the Squish format. -$ specifies the use of the Squish format. Usually you will start an announcement area definition with the AreaTag statement in its simplest form: AreaTag <Tag> FLM will look-up the <Tag> in Squish.Cfg to find the corresponding path, type and primary address. A local "FromNode" statement can be used to override the primary address for the area (including -p<address> specifications) found in Squish.Cfg. If this is an EchoArea, its <Tag> will be output to the EchoToss.Log whenever FLM writes to this area. If this is a NetArea, as a default, the Origin will not be used and the Private attribute will be set; you can override this with local "Origin" and "Attr" statements . In the case you are not using Squish as your mail processor (or for some strange reason you want to override its information), you can use the AreaTag statement in its full form to supply FLM with the necessary <path> and type for the area. If this is not an echo area, you do not need a <Tag> for echotoss.log, so you should use the AreaPath statement. Any of the statements described above in this "New File Announcements" section can be used after the AreaTag/AreaPath statement to override the defaults for this announcement area only. Please note that you can use different AreaTag/AreaPath definitions with the same message area Tag/Path, in order to announce different file areas in different messages but in the same message area. Examples: AreaTag OS2BBS AreaTag OS2BBS d:\bbs\mail\os2bbs -$ AreaPath d:\bbs\mail\net The following statements must be used after AreaTag/AreaPath and relate to the current Area only. In this section you can also use the statements described in the "Global or Local override" section above: they will be treated as local overrides (for the current Area only) to the corresponding statements specified as global default before the first Area definition. Announce <WTag> ... NoAnnounce <WTag> ... This defines the list of file areas to be announced in the current announcement message area. All the TAGs that match one of the <WTag> in "Announce" and do not match any of the <WTag> in "NoAnnounce" are announced in the area defined by the previous AreaTag/AreaPath. Obviously you can omit the "NoAnnounce" statement if you do not need to exclude areas that have been included via the "Announce" statement. There are two special TAGS that can be used in the "Announce" statement: "<DUPES>" and "<DEF>". "<DUPES>" is used to announce duplicate files that are removed from the UniFiles.Idx index. No duplicate report is done if FLM is not configured to manage the filebase ("OkMaxFiles" or "FBCompile" statements). A separate announcement is generated, before the new-file ones. Should you want to exclude some areas or paths from the duplicate report, please see the "NoAnnDupeTag" and "NoAnnDupePath" statements in the main global section. "<DEF>" is used to announce all the files that have not been announced elsewhere. A separate announcement is generated after all other announcements have been completed, even if "<DEF>" is listed together with other TAGs. Examples: Announce DOSUTI OS2* NoAnnounce OS2BBS This announces the file areas with tag "DOSUTI" and all those whose TAG starts with "OS2" but "OS2BBS". Announce PRIVFILE <DEF> <DUPES> This announces in different messages: - All the duplicate files found while building the UniFiles.Idx index (if OkMaxFiles or FBCompile statements are used) - New files found in area "PRIVFILE" - All the new files that have not been announced elsewhere. Complete example of the announcement definition section: ; Defaults for all subsequent area definitions FromNode 2:332/504.0 ToNode 2:332/504.0 From Alberto Pasquale To All Subj New Local Files Attr Prefix PREFIX.FLM Origin <APWORKS Modena I><Tel.+39-59-246112/3> Suffix SUFFIX.FLM ; Announcement areas: each statement is local to the preceding ; AreaTag/AreaPath and overrides the default one. AreaTag SWN_332.500 Announce 1!* NoAnnounce 1!ap* 1!harald* 1!up* AreaTag SYSOP_332.504 Announce <DUPES> From FLM To AsstSysOps Subj Dupe Report Prefix Suffix AreaTag SYSOP_332.504 Announce 1!up* From FLM To AsstSysOps Subj Upload Report Prefix Suffix AreaPath d:\msg\local -$ Announce * Subj Local file news HighAsciiOk S H A R E W A R E If you like this program and continue using it, you should pay the author for his work, as per the ShareWare concept of distribution. Please see LICENSE.DOC and REGISTER.DOC for information. Thank you for your interest in ApWorks programs.